API Documentation
Public Member Functions | List of all members
nkDebug::TestRunResult Class Referencefinal

Holds informations about a test execution result. More...

Public Member Functions

 TestRunResult ()
 
 TestRunResult (const nkMemory::StringView &rejectionReason)
 
 TestRunResult (const TestRunException &exception)
 
nkMemory::StringView getRejectionReason () const
 
nkMemory::BufferView< TestStackLevelgetRejectionStack () const
 
bool getSuccess () const
 
TestRunResultoperator= (const TestRunException &exception)
 

Detailed Description

Holds informations about a test execution result.

Constructor & Destructor Documentation

◆ TestRunResult() [1/3]

nkDebug::TestRunResult::TestRunResult ( )

Default constructor, defaulting to a successful result.

◆ TestRunResult() [2/3]

nkDebug::TestRunResult::TestRunResult ( const nkMemory::StringView rejectionReason)

Rejection constructor.

Parameters
rejectionReasonThe reason for rejecting the test.

◆ TestRunResult() [3/3]

nkDebug::TestRunResult::TestRunResult ( const TestRunException exception)

Translation constructor.

Parameters
exceptionThe exception to translate from.

Member Function Documentation

◆ getRejectionReason()

nkMemory::StringView nkDebug::TestRunResult::getRejectionReason ( ) const
Returns
The rejection reason provided.

◆ getRejectionStack()

nkMemory::BufferView<TestStackLevel> nkDebug::TestRunResult::getRejectionStack ( ) const
Returns
The stack at failure time if an exception has been provided during construction.

◆ getSuccess()

bool nkDebug::TestRunResult::getSuccess ( ) const
Returns
Whether the result is a success (true) or not (false).

◆ operator=()

TestRunResult& nkDebug::TestRunResult::operator= ( const TestRunException exception)

Overload for exception assignment operator.

Parameters
exceptionThe exception to translate from.
Returns
The calling instance once updated.

The documentation for this class was generated from the following file: